@database 01261410-0
@master Data:GFXLAB24/Docs/English/GfxLab24_Arexx.guide
@$VER: 1.0
@author "Rodrigo Reyes"
@(c) "Rodrigo Reyes 1994-1995"
@wordwrap
@remark Created with Heddley v1.1 (c) Edd Dumbill 1994

@node "Main" "GfxLab : ARexx port"

 AREXX PORT
 ==========

   The ARexx port of GfxLab24 allows to easily automate boring
   processing of pictures.

   The ARexx programm should be launched in an extern shell as follow:

   [Open a shell or a cli]
   [type as follow]
   rx <SCRIPT NAME> [PARAMETERS]

   Here is a list of the ARexx commands of GfxLab24. They interrest
   you only if you are able to write ARexx scripts. Otherwise, just
   use the scripts included in the package.

  The parameters in < > are necessary. Those in [ ] are optional.

   @{"Load          " link "ArexxLoad" 0}  @{"Emboss        " link "ARexxEmboss" 0} @{"GetWidth        " link "ARexxPictureWidth" 0}  @{"TextColor       " link "ARexxTextColor" 0}
   @{"Save          " link "ARexxSave" 0}  @{"Sketch        " link "ARexxSketch" 0} @{"FastColorMap    " link "ARexxFastColorMap" 0}  @{"TextFont        " link "ARexxTextFont" 0}
   @{"ColourToGray  " link "ARexxColourToGray" 0}  @{"Quake         " link "ARexxQuake" 0} @{"Request         " link "ARexxRequest" 0}  @{"TextSize        " link "ARexxTextSize" 0}
   @{"Brightness    " link "ARexxBrightness" 0}  @{"DispersePixel " link "ARexxDispersePixel" 0} @{"PrintInfo       " link "ARexxPrintInfo" 0}  @{"ClearBank       " link "ARexxClearBank" 0}
   @{"Filter        " link "ARexxFilter" 0}  @{"Convolve      " link "ARexxConvolve" 0} @{"GetFromPattern  " link "ARexxGetFromPattern" 0}  @{"BitmapToRaw     " link "ARexxBitmapToRaw" 0}
   @{"BiColor       " link "ARexxBicolor" 0}  @{"RemIsolated   " link "ARexxRemoveIsolatedPixel" 0} @{"BalanceFilter   " link "ARexxBalanceFilter" 0}  @{"TransparentColor" link "ARexxTransparentColor" 0}
   @{"Flip          " link "ARexxFlip" 0}  @{"Quantize      " link "ARexxQuantize" 0} @{"Rotate          " link "ARexxRotate" 0}  @{"DisplayMode     " link "ARexxDisplayMode" 0}
   @{"Crop          " link "ARexxCrop" 0}  @{"LoadPalette   " link "ARexxLoadPalette" 0} @{"Fade            " link "ARexxFade" 0}  @{"Whirl           " link "ARexxWhirl" 0}
   @{"Scale         " link "ARexxScale" 0}  @{"SavePalette   " link "ARexxSavePalette" 0} @{"CopyBrush       " link "ARexxCopyBrush" 0}  @{"Noise           " link "ARexxNoise" 0}
   @{"Negative      " link "ARexxNegative" 0}  @{"CountColor    " link "ARexxCountColor" 0} @{"CreatePicture   " link "ARexxCreatePicture" 0}  @{"Is24Bits        " link "ARexxIs24Bits" 0}
   @{"Visual        " link "ARexxVisual" 0}  @{"GetHeight     " link "ARexxPictureHeight" 0} @{"AddText         " link "ARexxAddText" 0}  @{"IsBitmap        " link "ARexxIsBitmap" 0}
   @{"Mosaic        " link "ARexxMosaic" 0}
@endnode

@node "ArexxLoad" "Port ARexx : LOAD"

 @{b} Nom de la commande:@{ub} @{"Load" link "GfxLab24.guide/Project_Load" 0}

  @{b}Syntax:@{ub} Load <NOM> [BANK 1-5]

  @{b}Parameters:@{ub}
        NAME : Name of the file to load.
              All the formats supported by GfxLab24 are accepted.

        BANK [1-5] : The command operates on the specified bank number.

  @{b}Result:@{ub}
        Return 'OK' if no error occurred, otherwise Return
        a message beginning with "ERROR", and which explains what
        happened.

  @{b}Example:@{ub}
            LOAD 'dh5:MyFile'

@endnode

@node "ARexxSave" "Port ARexx : Save"

 @{b} Nom de la commande:@{ub} @{"Save" link "GfxLab24.guide/Project_Save24bits" 0}

  @{b}Syntax:@{ub} Save <NOM> [FORMAT]

 @{b}Parameters:@{ub}
       NAME: Name of the file to save. This name can contain a path,
             otherwise the current GfxLab24 path is used.

       FORMAT: This optionnal parameter allows to save the picture in
             a specified format. FORMAT can be either "JPEG", "IFF24",
             "IFF", "TARGA", or "PCX".
             The default format, if not specified, is IFF24.

        BANK [1-5] : The command operates on the specified bank
            number.

 @{b}Result:@{ub}
        Returns 'OK' if no error occurred, otherwise returns
        a message beginning with "ERROR", and which explains what
        happened.


  @{b}Example:@{ub}
            Save 'df0:MyFile' JPEG
@endnode

@node "ARexxColourToGray" "Port ARexx : Colour To Gray"

 @{b} Nom de la commande:@{ub} @{"ColorToGray" link "GfxLab24.guide/OP_ColToGray" 0}

  Syntax: ColorToGray <RED> <GREEN> <BLUE> [BANK 1-5]
        ou ColorToGray <PAL | HDTV> [BANK 1-5]

 @{b}Parameters:@{ub}

    <RED>  : Red component weighting, contained between 0 and 10000.
             The default is 2989.

    <GREEN>: Green component weighting. The default is 5866.

    <BLUE> : Blue component weighting. The default is 1144.

    <PAL | HDTV>: If one of the keyword "PAL" or "HDTV" is found, the
             components weighting corresponds to the specified format.


    [BANK 1-5] : The command operates on the specified bank number.

 @{b}Result:@{ub}
        Returns "OK" if no error occurred, otherwise returns
        a message beginning with "ERROR", and which explains what
        happened.

  Exemple:

     ColorToGray 1200 5600 7899
     ColorToGray PAL BANK 3
@endnode

@node "ARexxBrightness" "Port ARexx : Brightness"

 @{b} Nom de la commande:@{ub}  @{"Brightness" link "GfxLab24.guide/OP_Brightness" 0}

  @{b}Syntax:@{ub}     Brightness <VALEUR>

 @{b}Parameters:@{ub}
        VALUE:  Can be any numerical value between 1 and 400. This can
                also be a keyword: "HALF", which means 50, or
                "DOUBLE" which means 200.

    [BANK 1-5] : The command operates on the specified bank number.

 @{b}Result:@{ub}
        Returns "OK" if no error occurred, otherwise returns
        a message beginning with "ERROR", and which explains what
        happened.

  Exemple:
            Brightness 75
            Brightness HALF
@endnode

@node "ARexxFilter" "Port ARexx : Filter"

 @{b} Nom de la commande:@{ub} @{"Filter" link "GfxLab24.guide/OP_Filter" 0}

  @{b}Syntax:@{ub} Filter <RED> <GREEN> <BLUE> [BANK 1-5]
      ou Filter <"RED" | "GREEN" | "BLUE"> [BANK 1-5]

 @{b}Parameters:@{ub}

    <RED>   : Weighting of the red component that must be filtered.

    <GREEN> : Weighting of the green component that must be filtered.

    <BLUE> :  Weighting of the blue component that must be filtered.

    <"RED" | "GREEN" | "BLUE"> : If one of this keywords are used, the
   weighting used correspond to the specified preset filter.

    [BANK 1-5] : The command operates on the specified bank number.

 @{b}Result:@{ub}
        Returns "OK" if no error occurred, otherwise returns
        a message beginning with "ERROR", and which explains what
        happened.

  @{b}Example:@{ub}
        Filter RED BANK 2
        Filter 110 80 60 BANK 1
        Filter GREEN
        Filter 100 50 100
@endnode

@node "ARexxBicolor" "Port ARexx : Bicolor"

 @{b} Nom de la commande:@{ub} @{"BiColor" link "GfxLab24.guide/OP_Bicolor" 0}

  @{b}Syntax:@{ub} Bicolor [METHOD] [THRESHOLD]

 @{b}Parameters:@{ub}

    [METHOD], is a keyword which can be any of the following:

               "NONE" (no dithering), is the default value
               "FLOYD" (Floyd-Steinberg)
               "BURKES"
               "STUCKI"
               "SIERRA"
               "JARVIS"
               "STEVENSON"
               "EDGES"
               "BOUNDARY"

     [THRESHOLD] is a number which represents the minimal threshold
            between two colours.

     [BANK 1-5] : The command operates on the specified bank number.

 @{b}Result:@{ub}
        Returns "OK" if no error occurred, otherwise returns
        a message beginning with "ERROR", and which explains what
        happened.

  @{b}Example:@{ub}
    BiColor
    BiColor BOUNDARY BANK 1
@endnode

@node "ARexxFlip" "Port ARexx : Flip"

 @{b} Nom de la commande:@{ub} @{"Flip" link "GfxLab24.guide/OP_Flip" 0}

  @{b}Syntax:@{ub} Flip [DIRECTION] [BANK 1-5]

 @{b}Parameters:@{ub}

    [DIRECTION] : Can be any of the keywords "HORIZONTAL" or
                 "VERTICAL". The default for this operator is
                 "HORIZONTAL".

    [BANK 1-5] : The command operates on the specified bank number.

 @{b}Result:@{ub}
        Returns "OK" if no error occurred, otherwise returns
        a message beginning with "ERROR", and which explains what
        happened.

 @{b}Example:@{ub}
    Flip VERTICAL BANK 3
    Flip
    Flip Bank 2
    Flip HORIZONTAL
@endnode

@node "ARexxCrop" "Port ARexx : Crop"

 @{b} Nom de la commande:@{ub} @{"Crop" link "GfxLab24.guide/OP_Crop" 0}

  @{b}Syntax:@{ub} Crop <X> <Y> <WIDTH> <HEIGHT> [BANK 1-5]

 @{b}Parameters:@{ub}

    <X> : Numerical value for the left offset of the picture.

    <Y> : Numerical value for the top offset of the picture.

    <WIDTH>: Numerical value for the width of the picture.

    <HEIGHT>: Numerical value for the height of the picture.

    [BANK 1-5] : The command operates on the specified bank number.

 @{b}Result:@{ub}
        Returns "OK" if no error occurred, otherwise returns
        a message beginning with "ERROR", and which explains what
        happened.

  @{b}Example:@{ub}
    CROP 10 10 200 200 BANK 5
    CROP -10 -10 512 512
@endnode

@node "ARexxScale" "Port ARexx : Scale"

 @{b} Nom de la commande:@{ub} @{"Scale" link "GfxLab24.guide/OP_Scale" 0}

  @{b}Syntax:@{ub} Scale <WIDTH> <HEIGHT> [BANK 1-5]

 @{b}Parameters:@{ub}

    <WIDTH>: Numerical value for the new width of the picture.

    <HEIGHT>: Numerical value for the new height of the picture.

    [BANK 1-5] : The command operates on the specified bank number.

 @{b}Result:@{ub}
        Returns "OK" if no error occurred, otherwise returns
        a message beginning with "ERROR", and which explains what
        happened.

  @{b}Example:@{ub}
    Scale 80 80 BANK 2
    Scale 100 100
@endnode

@node "ARexxNegative" "Port ARexx : Negative"

 @{b} Nom de la commande:@{ub} @{"Negative" link "GfxLab24.guide/OP_Negative" 0}

  @{b}Syntax:@{ub} Negative <RED> <GREEN> <BLUE> [BANK 1-5]
       ou Negative <"RED"|"GREEN"|"BLUE"|"DEFAULT"|"ALL"> [BANK 1-5]

 @{b}Parameters:@{ub}

    <RED>
    <GREEN>
    <BLUE>  : Shall contain a boolean value (0 or 1) for each
              component. If the value for a component is 0, then it
              will not be modified.


    <"RED"|"GREEN"|"BLUE"|"DEFAULT"|"ALL"> is a keyword which can be
   any of those specified. If the keyword is "RED", then only the red
   component will be inversed (or the green one with "GREEN", or the
   blue one with "BLUE", or all with "DEFAULT" or "ALL").


    [BANK 1-5] : The command operates on the specified bank number.

 @{b}Result:@{ub}
        Returns "OK" if no error occurred, otherwise returns
        a message beginning with "ERROR", and which explains what
        happened.

  @{b}Example:@{ub}
    Negative 1 0 1
    Negative ALL BANK 4
    Negative RED
    Negative 1 1 1 BANK 2
@endnode

@node "ARexxVisual" "Port ARexx : Visual"

 @{b} Nom de la commande:@{ub} @{"Visual" link "GfxLab24.guide/OP_VisualAspect" 0}

  @{b}Syntax:@{ub} Visual <RES> <LACE> <XRATIO> <YRATIO> [BANK 1-5]

 @{b}Parameters:@{ub}

    <RES> : Shall be one of the following keyword: "LORES", "HIRES",
   or "SUPERHIRES".

    <LACE> : shall be one of the following keyword: "LACE" or
   "NOLACE".

    <XRATIO> : numerical value containing the X ratio for the picture.

    <YRATIO> : numerical value containing the X ratio for the picture.

    [BANK 1-5] : The command operates on the specified bank number.

 @{b}Result:@{ub}
        Returns "OK" if no error occurred, otherwise returns
        a message beginning with "ERROR", and which explains what
        happened.

  @{b}Example:@{ub}
    Visual SUPERHIRES LACE 22 44
    Visual LORES NOLACE 22 22 BANK 2
@endnode

@node "ARexxEmboss" "Port ARexx : Emboss"

 @{b} Nom de la commande:@{ub} @{"Emboss" link "GfxLab24.guide/OP_Emboss" 0}

  @{b}Syntax:@{ub} Emboss [x] [y] [lumi] [thres]  [BANK 1-5]

 @{b}Parameters:@{ub}

    [x] : a numerical value which represents the horizontal shifting.
          The default value is 1.

    [y] : a numerical value which represents the vertical shifting.
          The default value is 1.

    [lumi] : is a numerical value, contained between 0 and 225. This
          represents the global brightness of the picture. The default is
          150.

    [Thres] : Threshold of the operator. Default is 1.

    [BANK 1-5] : The command operates on the specified bank number.

 @{b}Result:@{ub}
        Returns "OK" if no error occurred, otherwise returns
        a message beginning with "ERROR", and which explains what
        happened.

  @{b}Example:@{ub}
    Emboss BANK 1
    Emboss 2 -1 150
    Emboss -1 -1 250 20 BANK 2
@endnode

@node "ARexxSketch" "Port ARexx : Sketch"

 @{b} Nom de la commande:@{ub} @{"Sketch" link "GfxLab24.guide/OP_Sketch" 0}

  @{b}Syntax:@{ub} Sketch [PENSIZE] [THRES] [DEEP] [BANK 1-5]

 @{b}Parameters:@{ub}

    [PENSIZE] : a numerical value which represents the pen width. The
                default is 2.

    [THRES] : The threshold for the operator. The default is 255
              (in the range 0-255).

    [DEEP] : The base color pour the pen. The default is 255.
              (in the range 0-255).

    [BANK 1-5] : The command operates on the specified bank number.

 @{b}Result:@{ub}
        Returns "OK" if no error occurred, otherwise returns
        a message beginning with "ERROR", and which explains what
        happened.

  Exemple:
    Sketch
    Sketch 3 150 200 BANK 1
    Sketch 2 BANK 2
@endnode

@node "ARexxQuake" "Port ARexx : Quake"

 @{b} Nom de la commande:@{ub} @{"Quake" link "GfxLab24.guide/OP_Quake" 0}

  @{b}Syntax:@{ub} Quake <RADIUS> [DIRECTION] [BANK 1-5]

 @{b}Parameters:@{ub}

    <RADIUS>: The Radius for the operation, in pixels.

    [DIRECTION]: Is a keyword, either "HORIZONTAL" or "VERTICAL". The
   default is "HORIZONTAL".

    [BANK 1-5] : The command operates on the specified bank number.

 @{b}Result:@{ub}
        Returns "OK" if no error occurred, otherwise returns
        a message beginning with "ERROR", and which explains what
        happened.

  Exemple:
    Quake 5
    Quake 10 VERTICAL BANK 1
    Quake 50 HORIZONTAL
@endnode

@node "ARexxDispersePixel" "Port ARexx : Disperse Pixel"

 @{b} Nom de la commande:@{ub} @{"DispersePixel" link "GfxLab24.guide/OP_DispersePixels" 0}

  @{b}Syntax:@{ub} DispersePixel <RADIUS> <PROBA> [BANK 1-5]

 @{b}Parameters:@{ub}

    <RADIUS>: The Radius for the operation, in pixels.

    <PROBA>: The percentage of probability for the pixel displacement
   to occur. At 100%, all the pixels will be moved.

    [BANK 1-5] : The command operates on the specified bank number.

 @{b}Result:@{ub}
        Returns "OK" if no error occurred, otherwise returns
        a message beginning with "ERROR", and which explains what
        happened.

  Exemple:
    DisplacePixel 5 100 BANK 1
    DisplacePixel 10 50
@endnode

@node "ARexxConvolve" "Port ARexx : Convolve"

 @{b} Nom de la commande:@{ub} @{"Convolve" link "GfxLab24.guide/OP_Convolution" 0}

  @{b}Syntax:@{ub} Convolve <FILENAME> [THRES] [BANK 1-5]

 @{b}Parameters:@{ub}

    <FILENAME>: The name of a convolution file. This filename shall
   contain a correct path to the file.

    [THRES]: Threshold to the operator. Please refer to the operator
   documentation for further details.

    [BANK 1-5] : The command operates on the specified bank number.

 @{b}Result:@{ub}
        Returns "OK" if no error occurred, otherwise returns
        a message beginning with "ERROR", and which explains what
        happened.

  Exemple:
    Convolve "Convolve/Blur5x5" 50
    Convolve "Convolve/Triangle" BANK 5
    Convolve "Convolve/Sharpening_1" 10 BANK 2
@endnode

@node "ARexxRemoveIsolatedPixel" "Port ARexx : Remove Isolated Pixels"

 @{b} Nom de la commande:@{ub} @{"RemIsolated" link "GfxLab24.guide/OP_RemoveIsolatedPixels" 0}

  @{b}Syntax:@{ub} RemIsolated <THRES> <CONTEXT> [BANK 1-5]

 @{b}Parameters:@{ub}

    <THRES>: The threshold for the operator. Should be contained
   between 0 and 255.

    <CONTEXT>: The context threshold. Should be between 0 and 255. See
   the operator documentation for further details.

    [BANK 1-5] : The command operates on the specified bank number.

 @{b}Result:@{ub}
        Returns "OK" if no error occurred, otherwise returns
        a message beginning with "ERROR", and which explains what
        happened.

  @{b}Example:@{ub}
    RemIsolated 200 50
    RemIsolated 100 0 BANK 1
@endnode

@node "ARexxQuantize" "Port ARexx : Quantize"

 @{b} Nom de la commande:@{ub} @{"Quantize" link "GfxLab24.guide/OP_Quantize" 0}

  @{b}Syntax:@{ub} Quantize <COLOURS> [BANK 1-5]

 @{b}Parameters:@{ub}

    [COLOURS]: The maximum number of colours that must be computed by
               the colour quantization. A new palette is created for
               the picture, containing this number of palette entries.

    [BANK 1-5] : The command operates on the specified bank number.

 @{b}Result:@{ub}
        Returns "OK" if no error occurred, otherwise returns
        a message beginning with "ERROR", and which explains what
        happened.

  @{b}Example:@{ub}
    Quantize 256 BANK 1
    Quantize 16
@endnode

@node "ARexxLoadPalette" "Port ARexx : Load Palette"

 @{b} Nom de la commande:@{ub} @{"LoadPalette" link "GfxLab24.guide/OP_Quantize" 0}

  @{b}Syntax:@{ub} LoadPalette <FILENAME> [BANK 1-5]

 @{b}Parameters:@{ub}

    <FILENAME>: The name for a palette file. The name shall
   contain a correct path for the file.

    [BANK 1-5] : The command operates on the specified bank number.

 @{b}Result:@{ub}
        Returns "OK" if no error occurred, otherwise returns
        a message beginning with "ERROR", and which explains what
        happened.

  @{b}Example:@{ub}
    LoadPalette "dh0:palettes/green.pal" BANK 1
    LoadPalette "Palette/mypal"    /* This is in GfxLab24's
                                        directory!! */
@endnode

@node "ARexxSavePalette" "Port ARexx : Save Palette"

 @{b} Nom de la commande:@{ub} @{"SavePalette" link "GfxLab24.guide/OP_Quantize" 0}

  @{b}Syntax:@{ub} SavePalette <FILENAME> [BANK 1-5]

 @{b}Parameters:@{ub}

    <FILENAME>: The name for a palette file. The name shall
   contain a correct path for the file.

    [BANK 1-5] : The command operates on the specified bank number.

 @{b}Result:@{ub}
        Returns "OK" if no error occurred, otherwise returns
        a message beginning with "ERROR", and which explains what
        happened.

  @{b}Example:@{ub}
    SavePalette "dh0:palettes/green.pal" BANK 1
    SavePalette "Palette/mypal"
@endnode

@node "ARexxCountColor" "Port ARexx : Count Colors"

 @{b} Nom de la commande:@{ub} @{"CountColors" link "GfxLab24.guide/OP_Quantize" 0}

  @{b}Syntax:@{ub} CountColors <LIMITED> [BANK 1-5]

 @{b}Parameters:@{ub}

    <LIMITED>: If the keywords "LIMITED" or "STOP" appear in the
   command line, the operator stops the counting when it reaches 4096
   colours.

    [BANK 1-5] : The command operates on the specified bank number.

 @{b}Result:@{ub}
        Return the number of colours counted in the picture, if no
        error occurred, otherwise returns a message beginning with
        "ERROR", and which explains what happened.

  @{b}Example:@{ub}
    CountColor LIMITED BANK 1
    CountColor Bank 2
    CountColor STOP
@endnode

@node "ARexxPictureWidth" "Port ARexx : GetWitdh"

 @{b} Nom de la commande:@{ub} GetWidth

  @{b}Syntax:@{ub} GetWidth [BANK 1-5]

 @{b}Parameters:@{ub}

    [BANK 1-5] : The command operates on the specified bank number.

 @{b}Result:@{ub}

    If the bank exists, returns the picture witdh. Otherwise, returns
   an error message beginning with "ERROR"...

  @{b}Example:@{ub}
    width = GetWidth BANK 1
    width = GetWidth
@endnode

@node "ARexxPictureHeight" "Port ARexx : GetHeight"

 @{b} Nom de la commande:@{ub} GetHeight

  @{b}Syntax:@{ub} GetHeight [BANK 1-5]

 @{b}Parameters:@{ub}

    [BANK 1-5] : The command operates on the specified bank number.

 @{b}Result:@{ub}
    If the bank exists, returns the picture height. Otherwise, returns
   an error message beginning with "ERROR"...

  @{b}Example:@{ub}
    height = GetHeight BANK 1
    height = GetHeight
@endnode

@node "ARexxFastColorMap" "Port ARexx : FastColorMap"

 @{b} Nom de la commande:@{ub} @{"FastColorMap" link "GfxLab24.guide/MenuPrefs_Preview" 0}

  @{b}Syntax:@{ub} FastColorMap <"ON" | "OFF">

 @{b}Parameters:@{ub}

    <"ON" | "OFF">: Is either "ON" or "OFF" to set ON or OFF the fast
   colormap option.

 @{b}Result:@{ub}
        Returns "OK" if no error occurred, otherwise returns
        a message beginning with "ERROR", and which explains what
        happened.

  @{b}Example:@{ub}
    FastColorMap ON
    FastColorMap OFF
@endnode

@node "ARexxRequest" "Port ARexx : Request"

 @{b} Nom de la commande:@{ub} Request

  @{b}Syntax:@{ub} Request <TEXT> <CHOICE>

   This function pops up a requester, containing a text and one or
   more button gadgets. The result is returned to the script.

 @{b}Parameters:@{ub}

    <TEXT>:  Shall contain the text to display. The text must begin
             with <"> and end with another <"> (double-quote).
             In an ARexx script, in order pass correctly the quotes,
             you must put all the text with double-quote between two
             <'> (coma) caracters. Thus, a text should be sent as:
             '"This is a correct text"'. A return can be specified in
             in the text by adding <\n> where needed.
             ie: '"This the first line\nAnd this is the second."'

    <CHOICE>:Shall contain the available choice(s) for the user (at
             least one!). The choices are contained between two <">
             and by two <'>, just like explained above, and are
             separated by the <|> symbol.
             ie: '"Choice 1 | Choice 2 | Choice 3"'.

 @{b}Result:@{ub}

      The choice number is returned in the following sequence:
      1,2,3,... ,0. Thus, the first gadget (on the left) is always
      one, while the last gadget is always 0 (the standart choice for
      "Cancel").

  Exemple:
    Request '"Do you wish to continue ?'" '" Yes | No "'
    Request '"Which format do you\nwish to use ?"' '"JPEG|TARGA"'
@endnode

@node "ARexxPrintInfo" "Port ARexx : Printinfo"

 @{b} Nom de la commande:@{ub} PrintInfo

  @{b}Syntax:@{ub} PrintInfo <TEXT>

    This function prints a text in the GfxLab24's screen.

 @{b}Parameters:@{ub}

    <TEXT>:  Shall contain the text to display. The text must begin
             with <"> and end with another <"> (double-quote).
             In an ARexx script, in order pass correctly the quotes,
             you must put all the text with double-quote between two
             <'> (coma) caracters. Thus, a text should be sent as:
             '"This is a correct text"'. A return can be specified in
             in the text by adding <\n> where needed.
             ie: '"This the first line\nAnd this is the second."'
 @{b}Result:@{ub}
        Always returns "OK".

  @{b}Example:@{ub}
    PrintInfo '"Starting EmptyScript.rexx script"'
    PrintInfo '"Spock ! What are you doing with that turtle??"'
    PrintInfo '"Operation cancelled."'
@endnode

@node "ARexxGetFromPattern" "Port ARexx : GetFromPattern"

 @{b} Nom de la commande:@{ub} GetFromPattern

  @{b}Syntax:@{ub} GetFromPattern <PATTERN>

   This function is used to make script writing easy. It takes any
   pattern, and return all the dos files matching with it.

 @{b}Parameters:@{ub}

   <PATTERN> : Any AmigaDos pattern, or just a single filename. ie
             "~(#?.info)" will return every files in the path that
             is not an icon. #?.jpeg will return every file which
             extension is ".jpeg". Pic#?.iff will return all the
             pictures beginning with "Pic", end ending with ".iff"
             (ie: pic001.iff, pic002.iff, pic003.iff, ...).

 @{b}Result:@{ub}

    Returns a string that contains all the AmigaDos file matching with
    the pattern. This string can easely be used by the WORD() ARexx
    command.


  @{b}Example:@{ub}
    GetFromPattern #?.jpeg
    GetFromPattern hello.iff
    GetFromPattern dh0:pictures/#?
@endnode

@node "ARexxBalanceFilter" "Port ARexx : BalanceFilter"

  @{b} Nom de la commande:@{ub} @{"BalanceFilter" link "GfxLab24.guide/OP_Balance" 0}

  @{b}Syntax:@{ub} BalanceFilter <FILENAME> [RED_OFF] [GREEN_OFF]
                                    [BLUE_OFF] [BANK 1-5]

    Applies the Balance Filter operator on a picture.

 @{b}Parameters:@{ub}

    <FILENAME>: The name of a BalanceFilter file. It shall contains a
   correct path to the file.

   [RED_OFF]
   [GREEN_OFF]
   [BLUE_OFF]: If one of this keyword is found, the specified
               component will not be affected by the operator.

    [BANK 1-5] : The command operates on the specified bank number.

 @{b}Result:@{ub}
        Returns "OK" if no error occurred, otherwise returns
        a message beginning with "ERROR", and which explains what
        happened.

  @{b}Example:@{ub}
    BalanceFilter Filter/AllGreen RED_OFF BANK 1
    BalanceFilter dh0:myfilters/myfilter GREEN_OFF BLUE_OFF
@endnode

@node "ARexxRotate" "Port ARexx : Rotate"

  @{b} Nom de la commande:@{ub} @{"Rotate" link "GfxLab24.guide/OP_Rotate" 0}

  @{b}Syntax:@{ub} Rotate <X> <Y> <ANGLE> <RADIUS | "FULLPICTURE">
         [BANK 1-5]

 @{b}Parameters:@{ub}

    <X> : X coordinate for the central point of the rotation.

    <Y> : Y Coordinate for the central point of the rotation.

    <ANGLE>: Radius of the rotation in degree.


    [BANK 1-5] : The command operates on the specified bank number.

 @{b}Result:@{ub}
        Returns "OK" if no error occurred, otherwise returns
        a message beginning with "ERROR", and which explains what
        happened.

  @{b}Example:@{ub}
    Rotate 100 100 45 FULLPICTURE BANK 1
    Rotate 200 200 80 50
    Rotate 200 150 145 100 BANK 2
@endnode

@node "ARexxFade" "Port ARexx : Fade"

  @{b} Nom de la commande:@{ub} @{"Fade" link "GfxLab24.guide/OP_Fade" 0}

  @{b}Syntax:@{ub} Fade <LEVEL> <FIRST bank> <LAST bank> <DEST bank>

 @{b}Parameters:@{ub}

    <LEVEL>: A value that determinates the percentage of the last
   picture that should be seen on the first one. At 0, the resulting
   picture will be the first one. At 100, the resulting picture will
   be the last one.

    <FIRST bank>: The keyword "FIRST" shall be followed by the number
             of the bank to use, or by one the keywords: "BLACK" for a
             black screen, "WHITE" for a white screen, or "CURRENT"
             for the current bank.

    <LAST bank>: The keyword "LAST", followed by the number
             of the bank to use, or by one the keywords: "BLACK" for a
             black screen, "WHITE" for a white screen, or "CURRENT"
             for the current bank.

    <DEST bank>: The keyword "DEST", followed by the number
             of the bank to use, or by the keyword "CURRENT" for the
             current bank.

 @{b}Result:@{ub}
        Returns "OK" if no error occurred, otherwise returns
        a message beginning with "ERROR", and which explains what
        happened.

  @{b}Example:@{ub}
    Fade 50 FIRST 1 LAST 2 DEST CURRENT
    Fade 80 FIRST CURRENT LAST BLACK DEST CURRENT
    Fade 10 First 5 LAST 4 DEST 3
@endnode

@node "ARexxCopyBrush" "Port ARexx : CopyBrush"

  @{b} Nom de la commande:@{ub} @{"CopyBrush" link "GfxLab24.guide/OP_Brush" 0}

  @{b}Syntax:@{ub} CopyBrush <DEST> <SOURCE> <X> <Y> [WIDTH] [HEIGHT]
                                      [FADE] ["TRANSPARENTCOLOR"]

 @{b}Parameters:@{ub}

    <DEST>:  The number of the destination bank, or the keyword
             "CURRENT" for the current bank.

    <SOURCE>: The number of the source bank, or the keyword "CURRENT"
              for the current bank.

    <X> : Numerical value for the left offset of the position where
   the brush will be copied.

    <Y> : Numerical value for the top offset of the position where the
          brush will be copied.

    [WIDTH]: Width of the area where the brush will be copied.
             The default is the width of the picture/brush.

    [HEIGHT]: Height of the area where the brush will be copied.
             The default is the height of the picture/brush.

    <LEVEL>: A value that determinates the percentage of the original
   picture that should be seen beyond the brush. At 0, the brush is
   not copied, while at 100 it is fully copied with no fade effect.

    ["TRANSPARENTCOLOR"] if specified, this keyword indicates that the
   transparent color of the brush will not be copied.

  @{b}Result:@{ub}
        Returns "OK" if no error occurred, otherwise returns
        a message beginning with "ERROR", and which explains what
        happened.

  @{b}Example:@{ub}
    CopyBrush CURRENT 4 50 50
    CopyBrush 4 CURRENT 0 0 200 200 75 TRANSPARENTCOLOR
@endnode

@node "ARexxCreatePicture" "Port ARexx : CreatePicture"

  @{b} Nom de la commande:@{ub} @{"CreatePicture" link "GfxLab24.guide/MenuEdit_CreateNewPicture" 0}

  @{b}Syntax:@{ub} CreatePicture <WIDTH> <HEIGHT> [RED] [GREEN]
                                               [ BLUE] [BANK 1-5]

    This function creates a new picture.

 @{b}Parameters:@{ub}

    <WIDTH>: width of the picture to create.

    <HEIGHT>: height of the picture to create.

    [RED]: The red component value for the background color (between 0
           and 255).

    [GREEN]: The green component value for the background color
   (between 0 and 255).

    [BLUE]: The blue component value for the background color
   (between 0 and 255).

    [BANK 1-5] : The command operates on the specified bank number.
             suit le mot-clef. Si cette précision est omise, la
             commande agit par défaut sur l'image en cours.

 @{b}Result:@{ub}
        Returns "OK" if no error occurred, otherwise returns
        a message beginning with "ERROR", and which explains what
        happened.

  Exemple:
    CreatePicture 512 512
    CreatePicture 256 256 255 0 0 BANK 2
    CreatePicture 500 500 BANK 1
@endnode

@node "ARexxAddText" "Port ARexx : AddText"

  @{b} Nom de la commande:@{ub} @{"AddText" link "GfxLab24.guide/OP_Text" 0}

  @{b}Syntax:@{ub} AddText <TEXT> <X> <Y> [BANK 1-5]

   This function put some text on a picture.

 @{b}Parameters:@{ub}

    <TEXT>:  Shall contain the text to display. The text must begin
             with <"> and end with another <"> (double-quote).
             In an ARexx script, in order pass correctly the quotes,
             you must put all the text with double-quote between two
             <'> (coma) caracters. Thus, a text should be sent as:
             '"This is a correct text"'. Line feeds are not allowed
             with this operator.

    <X> : Numerical value for the left offset of the position where
          the text will be copied.

    <Y> : Numerical value for the top offset of the position where the
          text will be copied.

    [BANK 1-5] : The command operates on the specified bank number.

 @{b}Result:@{ub}
        Returns "OK" if no error occurred, otherwise returns
        a message beginning with "ERROR", and which explains what
        happened.

  @{b}Example:@{ub}
    AddText '"Hello World !"' 100 100
    AddText '"How do you do ?"' 100 100 BANK 2
@endnode

@node "ARexxTextColor" "Port ARexx : TextColor"

  @{b} Nom de la commande:@{ub} @{"TextColor" link "GfxLab24.guide/OP_Text" 0}

  @{b}Syntax:@{ub} TextColor <RED> <GREEN> <BLUE>

   This function defines the color of the text for the TEXT operator.

 @{b}Parameters:@{ub}

    [RED]: The red component value for the text color (between 0
           and 255).

    [GREEN]: The green component value for the text color (between 0
            and 255).

    [BLUE]: The blue component value for the text color (between 0 and
            255).


 @{b}Result:@{ub}
        Returns "OK" if no error occurred, otherwise returns
        a message beginning with "ERROR", and which explains what
        happened.

  @{b}Example:@{ub}
    TextColor 0 0 0
    TextColor 255 255 0
    TextColor 120 120 250
@endnode

@node "ARexxTextFont" "Port ARexx : TextFont"

  @{b} Nom de la commande:@{ub} @{"TextFont" link "GfxLab24.guide/OP_Text" 0}

  @{b}Syntax:@{ub} TextFont <FONT>

    This function defines the name of the font to use with the Text
   operator.

 @{b}Parameters:@{ub}

    <FONT> : name of the font.

 @{b}Result:@{ub}
        Returns "OK" if no error occurred, otherwise returns
        a message beginning with "ERROR", and which explains what
        happened.

  @{b}Example:@{ub}
    TextFont topaz.font
    TextFont mybeautifulfont.font
@endnode

@node "ARexxTextSize" "Port ARexx : TextSize"

  @{b} Nom de la commande:@{ub} @{"TextSize" link "GfxLab24.guide/OP_Text" 0}

  @{b}Syntax:@{ub} TextSize <Size>

    This function defines the size of the font to use with the Text
   operator.

 @{b}Parameters:@{ub}

    <SIZE> : Size of the font.

 @{b}Result:@{ub}
        Returns "OK" if no error occurred, otherwise returns
        a message beginning with "ERROR", and which explains what
        happened.

  @{b}Example:@{ub}
    TextSize 30
    TextSize 8
    TextSize 90
@endnode

@node "ARexxClearBank" "Port ARexx : ClearBank"

  @{b} Nom de la commande:@{ub} @{"ClearBank" link "GfxLab24.guide/MenuEdit_ClearBank" 0}

  @{b}Syntax:@{ub} ClearBank [BANK 1-5]

   This function clears a bank. It deletes the picture from memory
   (not from disk, of course) by freeing all the ressources allocated.

 @{b}Parameters:@{ub}

    [BANK 1-5] : The command operates on the specified bank number.

 @{b}Result:@{ub}
        Returns "OK" if no error occurred, otherwise returns
        a message beginning with "ERROR", and which explains what
        happened.

  @{b}Example:@{ub}
    ClearBank
    ClearBank BANK 2
@endnode

@node "ARexxBitmapToRaw" "Port ARexx : BitmapToRaw"

  @{b} Nom de la commande:@{ub} @{"BitmapToRaw" link "GfxLab24.guide/MenuEdit_BitMapToRaw" 0}

  @{b}Syntax:@{ub} BitmapToRaw [BANK 1-5]

   This function creates a 24-bits buffer from a bitmap picture.

 @{b}Parameters:@{ub}

    [BANK 1-5] : The command operates on the specified bank number.

 @{b}Result:@{ub}
        Returns "OK" if no error occurred, otherwise returns
        a message beginning with "ERROR", and which explains what
        happened.

  @{b}Example:@{ub}
    BitmapToRaw Bank 2
    BitmapToRaw
    BitmapToRaw Bank 5
@endnode

@node "ARexxTransparentColor" "Port ARexx : TransparentColor"

  @{b} Nom de la commande:@{ub} @{"TransparentColor" link "GfxLab24.guide/MenuEdit_Transparent" 0}

  @{b}Syntax:@{ub} TransparentColor <BITMAP color> [BANK 1-5]
       ou TransparentColor <24BITS red green blue> [TOL] [BANK 1-5]

   Indicates which is the transparent color for a bitmap or a 24-bits
   buffer.

 @{b}Parameters:@{ub}

    <BITMAP color> : If the keyword "BITMAP" appears, it should be
            followed by a value that indicates which is the
            transparent color in the palette entry.

    <24BITS red green blue>: If the keyword "24BITS" appears, it
            should be followed by the values of the red, green, and
            blue components. Those values determinates the
            transparent color of that picture.

    [TOL]: This argument is only available for 24-bits pictures, and
   indicates the percentage of tolerance for the transparent color.


    [BANK 1-5] : The command operates on the specified bank number.

 @{b}Result:@{ub}
        Returns "OK" if no error occurred, otherwise returns
        a message beginning with "ERROR", and which explains what
        happened.

  @{b}Example:@{ub}
    TransparentColor BITMAP 5
    TransparentColor BITMAP 0 BANK 3
    TransparentColor 24BITS 255 0 255 10 BANK 4
    TransparentColor 24BITS 255 255 255 BANK 2
@endnode

@node "ARexxDisplayMode" "Port ARexx : DisplayMode"

  @{b} Nom de la commande:@{ub} @{"DisplayMode" link "GfxLab24.guide/MenuPrefs_Preview" 0}

  @{b}Syntax:@{ub} DisplayMode [MODE] ...

    This functions allows to select the display mode of the 24-bits
    pictures.

 @{b}Parameters:@{ub}

    [MODE] : Can be any of the following keyword:
                HAM      : to set HAM mode on.
                NOHAM    : to set HAM mode off.
                LOWRES   : to select the low resolution display.
                HIRES    : to select the high resolution.
                SUPERHIRES: to select the superhigh resolution.
                LACE     : to select the interlaced mode.
                NOLACE   : to select the non-interlaced mode.
                PAL      : to select a PAL moniteur display
                NTSC     : for a NTSC monitor.
                DEPTH x  : to select the number of bitplanes for the
                           display.
                FASTCOLORMAP: to set the fastcolormap mode on.
                NOFASTCOLORMAP: to set the fastcolormap mode off.
                DITHERING <name>: To select the dithering mode, where
                          <name> can be either "HALFTONE", "ERROR",
                          or "NONE".

 @{b}Result:@{ub}
        Returns "OK" if no error occurred, otherwise returns
        a message beginning with "ERROR", and which explains what
        happened.

  @{b}Example:@{ub}
    DisplayMode LORES LACE HAM
    DisplayMode PAL SUPERHIRES DEPTH 8 HAM LACE
@endnode

@node "ARexxWhirl" "Port ARexx : Whirl"

  @{b} Nom de la commande:@{ub} @{"Whirl" link "GfxLab24.guide/OP_Whirl" 0}

  @{b}Syntax:@{ub} Whirl <X> <Y> <LEVEL> [BANK 1-5]

 @{b}Parameters:@{ub}

    <X> : X coordinate for the central point of the rotation.

    <Y> : Y Coordinate for the central point of the rotation.

    <LEVEL>: Rotation level for the whirl effect.

    [BANK 1-5] : The command operates on the specified bank number.

 @{b}Result:@{ub}
        Returns "OK" if no error occurred, otherwise returns
        a message beginning with "ERROR", and which explains what
        happened.

  @{b}Example:@{ub}
    Whirl 50 50 200
    Whirl 200 200 10
    Whirl 200 200 800
@endnode

@node "ARexxNoise" "Port ARexx : Noise"

  @{b} Nom de la commande:@{ub} @{"Noise" link "GfxLab24.guide/OP_Noise" 0}

  @{b}Syntax:@{ub} Noise <WHITE x> [BANK 1-5]
        ou Noise [RED x] [GREEN x] [BLUE x] [BANK 1-5]

 @{b}Parameters:@{ub}

    <WHITE x> : indicates the percentage of white noise for the
   picture. x must be 0<= x <=100.

    [RED x] : indicates the percentage of red noise for the
   picture. x must be 0<= x <=100.

    [GREEN x] : indicates the percentage of green noise for the
   picture. x must be 0<= x <=100.

    [BLUE x] : indicates the percentage of blue noise for the
   picture. x must be 0<= x <=100.

    [BANK 1-5] : The command operates on the specified bank number.

 @{b}Result:@{ub}
        Returns "OK" if no error occurred, otherwise returns
        a message beginning with "ERROR", and which explains what
        happened.

  @{b}Example:@{ub}
    Noise WHITE 50 BANK 2
    Noise WHITE 10
    Noise RED 20 GREEN 30 BANK 2
    Noise BLUE 10 RED 20
    Noise GREEN 10
@endnode

@node "ARexxIsBitmap" "Port ARexx : IsBitmap"

  @{b} Nom de la commande:@{ub} @{"IsBitmap" link "GfxLab24.guide/LesBanques" 0}

  @{b}Syntax:@{ub} IsBitmap [BANK 1-5]

 @{b}Parameters:@{ub}

    [BANK 1-5] : The command operates on the specified bank number.

 @{b}Result:@{ub}

    Returns "OK" if the bank has a bitmap buffer, or "ERROR"
   otherwise.

  @{b}Example:@{ub}
    IsBitmap BANK 2
    IsBitmap
@endnode

@node "ARexxIs24Bits" "Port ARexx : Is24Bits"

  @{b} Nom de la commande:@{ub} @{"Is24Bits" link "GfxLab24.guide/LesBanques" 0}

  @{b}Syntax:@{ub} Is24Bits [BANK 1-5]

 @{b}Parameters:@{ub}

    [BANK 1-5] : The command operates on the specified bank number.

 @{b}Result:@{ub}

    Returns "OK" if the bank has a 24-bits buffer, or "ERROR"
   otherwise.

  @{b}Example:@{ub}

    Is24Bits BANK 5
    Is24Bits
@endnode

@node "ARexxMosaic" "Port ARexx : Mosaic"

  @{b} Nom de la commande:@{ub} @{"Mosaic" link "GfxLab24.guide/OP_Mosaic" 0}

  @{b}Syntax:@{ub} Whirl <Size> [CRACKLING] [BANK 1-5]

 @{b}Parameters:@{ub}

    <Size> : Size of a piece of mosaic, in pixels.

    [CRACKLING] : If this keyword appears, the operator will apply some
             crackling effect on the mosaic.

    [BANK 1-5] : The command operates on the specified bank number.

 @{b}Result:@{ub}
        Returns "OK" if no error occurred, otherwise returns
        a message beginning with "ERROR", and which explains what
        happened.

  @{b}Example:@{ub}
    MOSAIC 30 CRACKLING
    MOSAIC 5
    MOSAIC 10 CRACKLING
@endnode